Skip to content

Prepare the drums package for PyPI - #5

Merged
sahiljagtap08 merged 7 commits into
mainfrom
pypi-release
Nov 12, 2026
Merged

sahiljagtap08 merged 7 commits into
mainfrom
pypi-release

Conversation

@sahiljagtap08

@sahiljagtap08 sahiljagtap08 commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Prepares the SDK for pip install drums-sdk (import name stays drums; PyPI rejected the project name drums as too similar to the existing drum). Nothing is uploaded by this PR; publishing happens when a v* tag is pushed after merge (see RELEASE.md).

What is in here

  • pyproject.toml: distribution name drums-sdk, version 0.2.5 (what drums.__version__ and the public docs already say; see "Version" below), readme, classifiers, project URLs (drums.run, console.drums.run/docs, this repo), requires-python >= 3.9, no runtime dependencies. No console script: the drums CLI is on the unmerged mcp-server branch (drums mcp: two-layer MCP stdio server, drums CLI, Claude Code plugin #3), so it is not included.
  • LICENSE: Apache License 2.0 text, ready. Owner decision pending: the SPDX line in pyproject.toml is commented out and the release workflow refuses to publish until it is set (RELEASE.md step 0.1). pyproject.toml has declared Apache-2.0 since the first commit; this PR does not change that decision, it asks for it to be confirmed.
  • README.md: a five-minute first page (install, DRUMS_URL + DRUMS_TOKEN, create a computer, screenshot, act, verify, destroy), links into the docs. CHANGELOG.md for 0.1.0 to 0.2.5.
  • .github/workflows/release.yml: on a v* tag, build, twine check --strict, install the wheel on 3.9 to 3.13 and run the suite against it, then publish to PyPI through Trusted Publishing (environment pypi, id-token: write). On workflow_dispatch, the same but to TestPyPI (environment testpypi). Gates: tag == version, __version__ == pyproject, license line set. Fallback to a PYPI_API_TOKEN / TEST_PYPI_API_TOKEN secret when one exists; no tokens in the repo. ci.yml runs the tests on PRs.
  • RELEASE.md: the exact owner steps: register the pending Trusted Publisher, create the environments, TestPyPI first and verify in a clean venv, tag, verify pip install drums.
  • Two docstrings and one comment referenced documents in the drumsd repo (docs/*.md) and an internal repo/branch name; they now point at console.drums.run/docs pages.

Trusted Publisher fields (pypi.org -> Account -> Publishing -> add a pending publisher)

Field Value
PyPI project name drums-sdk
Owner Drums-Labs
Repository name drums-python-sdk
Workflow name release.yml
Environment name pypi (TestPyPI: testpypi)

Version

The brief asked for 0.2.0 to match the v0.2.0 git tag. That tag sits on the same commit as main, but the package there already says 0.2.5 (bumped five times, 2026-10-30 to 10-31), the operator-sent wheel was drums-0.2.5-py3-none-any.whl, and the public docs name 0.2.5. Publishing a lower number would make PyPI look older than the wheels people already have. So the first PyPI release is 0.2.5 and the tag to push is v0.2.5; the v0.2.0 tag is left alone. If you want a different number, change it in pyproject.toml and drums/__init__.py (the workflow checks they agree).

Audit

  • No secrets, keys or credentials in the tree or in the built sdist/wheel. The only hosts are 127.0.0.1 (fake daemon in tests, local drumsd default). Paths are inside the guest desktop (/home/user, /etc/drums/token).
  • No pricing. (Client.metrics() docstring describes a "cost" field computed from host price x wall time; that is a metric name, not a price.)
  • Env var: the SDK and the docs use DRUMS_TOKEN, not DRUMS_API_KEY; the README follows the code.

Verified locally

python -m build and twine check --strict: pass. Wheel installed into clean venvs and the 32-test suite run against the installed package from outside the repo: Python 3.9.6, 3.10.22, 3.12.5, 3.13.4 all OK; import drums; drums.Client OK on each.

…iers, URLs; Apache-2.0 LICENSE text pending the owner's confirmation; MANIFEST.in
…, screenshot, verify, destroy); CHANGELOG for 0.1.0 to 0.2.5
…d Publishing to PyPI on v* tags and TestPyPI on dispatch; CI; RELEASE.md with the owner's steps
@sahiljagtap08
sahiljagtap08 marked this pull request as ready for review November 12, 2026 08:20
@sahiljagtap08
sahiljagtap08 merged commit 3c72c65 into main Nov 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant